CUBE CONNECT Edition Help

Markdown your project

Whenever a new CUBE project is created or imported from a CUBE 6 catalog, the option to create a README.md file is available. The README file corresponds to a text file that uses Markdown language to format the elements in the file. This file can be used to summarize certain aspects of the model.

Note: The README.md file that will be added to your project’s directory corresponds to a template with the different types of elements and its notation in markdown, which the user can modify
  1. Open the README.md file:
    1. File > Open > Select the file from the project’s directory
    2. After creating/importing a project the .md file will be automatically opened.
  2. Click on the Open Editor symbol
  3. The Editor will open at the bottom of the screen:

  4. Use the guidelines listed in Markdown Editor to modify the file as desired. :
    Note: Any edits done in the Editor will be directly available in the preview window above.
Note: The template contains additional formatting options and their appropriate notation in markdown language like tables, links, etc.

5. Click on Save when done

6. Click on the Open Editor symbol to close it